get /cloudextensions

List Cloud Extensions (getCloudExtensions)

Lists the Cloud Extensions.

Consumes

This API call consumes the following media types via the Content-Type request header:

  • application/json

Return type

array[CloudExtensionDescription]

stateInfo (optional)

CloudExtensionStateDescription

Cloud Extension state description

id (optional)

CloudExtensionId

value (optional)

String Entity ID

_type

String Cloud Extension ID

Enum:

CloudExtensionId

name (optional)

String Cloud Extension name

uuid (optional)

UUID Cloud Extension UUID format: uuid

cloudProvider (optional)

CloudProvider

Cloud provider - AWS, Azure, or Gcp

currentTask (optional)

TaskId

value (optional)

String Entity ID

_type

String Task ID

Enum:

TaskId

healthChecks (optional)

array[HealthCheckResultDetails] Cloud Extension health checks

lastTimeSeenActive (optional)

Date Last date and time the Cloud Extension was seen active format: date-time

state (optional)

CloudExtensionState

Cloud Extension state

credentialsId (optional)

CredentialsId

value (optional)

String Entity ID

_type

String Credentials ID

Enum:

CredentialsId

cloudInfo (optional)

CloudExtensionBase

Cloud extension object

credentials (optional)

CredentialsId

value (optional)

String Entity ID

_type

String Credentials ID

Enum:

CredentialsId

size (optional)

CeSize

Cloud Extension Size - Large or Small

licenseType (optional)

LicenseType

License Type - VelostrataIssued or Marketplace. If you select VelostrataIssued to deploy a CloudExtension using a Velostrata Manager installed using your Azure Subscription ID/AWS Account ID, you are required to contact Velostrata to first register your product for non-Azure/non-AWS Marketplace use and verify a corresponding license is purchased and valid.

cloudEdges (optional)

array[CloudEdge] Cloud Edges

proxy (optional)

ProxyConfiguration

host

String Proxy host

port

Integer Proxy port format: int32

useForData

Boolean Use for data or not

vmExporters (optional)

array[VmExporter] The exporter runs through all data disks and converts them to native cloud disks, after this first iteration is completed, the exporter continues to write the changes committed since its previous execution. This task runs in cycles.

vmImporters (optional)

array[VmImporter] The importer runs through all data disks and converts them to native cloud disks, after this first iteration is completed, the importer continues to write the changes committed since its previous execution. This task runs in cycles.

workloadDefaultSecurityGroupId (optional)

String Security group to which the workloads will belong.

workloadDefaultSubnetId (optional)

String Subnet in which the workloads will reside.

_type

String AWS, Azure or GCP Cloud Extension

Enum:

AzureCloudExtension

AwsCloudExtension

GcpCouldExtension

onPremInfo (optional)

OriginDescription

Origin Virtual Machine Description

entityId

String

cloudDetailsName (optional)

String Cloud Details name, if exists

 

operationLinks (optional)

OperationLink

List of Links to CE Operations

OperationLinks

array[OperationLink] (optional)

 

 

Example data

Content-Type: application/json

[ {

"cloudInfo" : {

"cloudEdges" : [ {

"networkInterfaceId" : "eni-123456",

"edgeNode" : { },

"instanceId" : "i-123456798",

"privateIp" : "12.34.56.78",

"_type" : "AzureCloudEdge",

"version" : "3"

}, {

"networkInterfaceId" : "eni-123456",

"edgeNode" : { },

"instanceId" : "i-123456798",

"privateIp" : "12.34.56.78",

"_type" : "AzureCloudEdge",

"version" : "3"

} ],

"licenseType" : { },

"proxy" : {

"port" : 3128,

"useForData" : false,

"host" : "local.proxy.com"

},

"size" : { },

"vmExporters" : [ "", "" ],

"credentials" : "",

"workloadDefaultSubnetId" : "subnet-123456789",

"_type" : "AzureCloudExtension",

"vmImporters" : [ "", "" ],

"workloadDefaultSecurityGroupId" : "sg-123456789"

},

"onPremInfo" : {

"cloudDetailsName" : "cloudDetailsName",

"entityId" : "entityId"

},

"stateInfo" : {

"healthChecks" : [ {

"result" : { },

"component" : { },

"healthCheck" : { },

"impact" : { },

"errorCode" : 140

}, {

"result" : { },

"component" : { },

"healthCheck" : { },

"impact" : { },

"errorCode" : 140

} ],

"lastTimeSeenActive" : "2000-01-23T04:56:07.000+00:00",

"cloudProvider" : { },

"name" : "cloudExtensionName",

"currentTask" : "",

"id" : "",

"state" : { },

"credentialsId" : "",

"uuid" : "123e4567-e89b-12d3-a456-426655440000"

"OperationLinks" : [ {

"rel: "start","

"href: "/velostrata/api/v35/cloudextensions/ce-1/operations/start"

"httpVerb: "POST"

},

{

"rel: "stop","

"href: "/velostrata/api/v35/cloudextensions/ce-1/operations/stop"

"httpVerb: "POST"

},

{

"rel: "reconfigure","

"href: "/velostrata/api/v35/cloudextensions/ce-1/operations/reconfigure"

"httpVerb: "POST"

},

{

"rel: "delete","

"href: "/velostrata/api/v35/cloudextensions/ce-1"

"httpVerb: "DELETE"

} ]

} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

  • application/json

Responses

200

OK

Default

Error ErrorInfo

errorCode (optional)

String

url(optional)

String

message (optional)

String